docs: document API-error exceptions and request timeouts#241
Merged
bjornars merged 2 commits intoJun 18, 2026
Conversation
Add a README "Error handling" section covering the two newest changes: - PR novem-code#236: writes now raise NovemException (or a subclass) carrying the server message instead of silently printing a placeholder. Documents the exception hierarchy (all importable from novem.exceptions) and the create PUT 409 no-op for objects that already exist. - PR novem-code#240: requests now time out instead of hanging, with the default (10s, 2min) and job.run() (30s, 30min) values and the resulting requests.exceptions.Timeout.
Align the README with the docs-site style guide: direct prose, em-dashes used sparingly (not paired twice a sentence), Oxford-spec punctuation, complete sentences, and Note: callouts. - NB: -> Note: on the two inline callouts - fix two comma splices and the "already exist" typo - add Oxford commas; recast the paired-em-dash asides as parentheses/sentences - keep single, well-placed em-dashes where they earn their place
sondove
approved these changes
Jun 18, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documents the two newest SDK changes in the README, which had no coverage of either behaviour.
What
NovemException(or a subclass) carrying the server message instead of the old silent print placeholder. New README Error handling section documents the exception hierarchy (all importable fromnovem.exceptions), atry/exceptexample, and the create-PUT 409 no-op for objects that already exist. Notes that thePlot(...)constructor itself is a create PUT (unlesscreate=False) and can raise.(10s connect, 2min read),job.run()allows(30s connect, 30min read), and exceeding either raisesrequests.exceptions.Timeout.Commits
docs: document API-error exceptions and request timeouts— the new content.docs: README style pass for docs-site conventions— aligns the README with the docs-site style guide (NB:→Note:, fix two comma splices and analready existtypo, add Oxford commas, recast paired-em-dash asides, keep single em-dashes where they fit).Docs-only; no code changes.